WOM Team (V1)

Content

Overview

The WOM Team API allows you to create teams in handling the work order jobs and to update and view created teams details.

Method

The following REST methods are available:

  • Creating Teams
  • Updating Teams
  • Viewing Team Details

Requirements

Authorization API calls
All API call request to ideabiz.lk required Authorization headers. Please refer the Token Management (http://docs.ideabiz.lk/Getting_Started/Token_Manegment) document for Authorization.

Request Header

Content-Type: application/json 
Authorization: Bearer [access token] 
Accept: application/json

Sample Request Header

Content-Type: application/json 
Authorization: Bearer a92ba8hjgjhgjh3fa1609cabcd79
Accept: application/json

Team Creation

Request

Given below is a sample request of the send service.

URL

https://ideabiz.lk/apicall/WomTeam/V1.0

Sample URL

https://ideabiz.lk/apicall/WomTeam/V1.0/{TEAMID}/{Channel}

Method

POST

Body

{
    "TeamId": "TEST_A",
    "RegionCode": "COL",
    "TeamLeader": "CLOSED",
    "Ownership": "Contractor",
    "VehicleType": "VAN",
    "DepotId": 1,
    "ContactNumber": "777123456,773333333",
    "ItouchReference": "123456",
    "AgentNic": "871111111V",
    "PmsId": "25412",
    "VehicletrackingId": "123545",
    "Description": "Test Team",
    "Email": "john@d.lk",
    "VehicleRegistrationNo": "251-8989"
}


Given below are the Request parameters for WOM Team Creation.





Parameter Name

Description

Type

Mandatory/Optional

TeamId

This is the unique Team ID (Uppercase).

String

Mandatory

RegionCode

This is the tagging region code for the creating team. This will be either COL or OUT.

String

Mandatory

TeamLeader

This is the team leader's name.

String

Mandatory

Ownership

This is to state the ownership of the creating team. Ownership will be given to either of the Courier Name or Contractor Name or Dialog.

String

Mandatory

VehicleType

This is to state the vehicle type for the creating team. Vehicle types are Van, Bike, 3Wheel, Cab and Lorry.

String

Mandatory

DepotId

This is the allocated depot ID for the team.

Numeric

Mandatory

ContactNumber

This is the contact number/numbers for the team. If multiple numbers are entering, they should be comma separated.

String

Optional

ItouchReference

This is Touch Reference Number.

String

Optional

AgentNic

This is the NIC number of the agent.

String

Optional

AgentMsisdn

This is the agent MSISDN number.

Numeric

Optional

PmsId

This is the Partner Management System ID.

String

Optional

VehicletrackingId

This is the vehicle tracking ID.

String

Optional

Description

This is to state a description for the creating team.

String

Optional

Email

This is to state a email address/addresses for the team.

String

Optional

VehicleRegistrationNo

This is the vehicle registration number.

String

Optional

Response

Status code  : 201

{
    "Description": "Successfully created the team",
    "TeamId": "TEST_A"
}

Update Team

Request

Given below is a sample request of the send service.

URL

https://ideabiz.lk/apicall/WomTeam/V1.0

Sample URL

https://ideabiz.lk/apicall/WomTeam/V1.0/{TEAMID}/{Channel}

Method

PUT

Body

{
    "TeamId": "TEST_A",
    "DepotId": 1,
    "RegionCode": "COL",
    "TeamLeader": "John Snow",
    "Ownership": "Dialog",
    "VehicleType": "VAN",
    "Email": "john@d.lk"
}


Given below are the Request parameters for WOM Team Updation.





Parameter Name

Description

Type

Mandatory/Optional

TeamId

This is the unique Team ID (Uppercase).

String

Mandatory

RegionCode

This is the tagging region code for the creating team. This will be either COL or OUT.

String

Optional

TeamLeader

This is the team leader's name.

String

Optional

Ownership

This is to state the ownership of the creating team. Ownership will be given to either of the Courier Name or Contractor Name or Dialog.

String

Optional

VehicleType

This is to state the vehicle type for the creating team. Vehicle types are Van, Bike, 3Wheel, Cab and Lorry.

String

Optional

DepotId

This is the allocated depot ID for the team.

Numeric

Mandatory

ContactNumber

This is the contact number/numbers for the team. If multiple numbers are entering, they should be comma separated.

String

Optional

ItouchReference

This is Touch Reference Number.

String

Optional

AgentNic

This is the NIC number of the agent.

String

Optional

AgentMsisdn

This is the agent MSISDN number.

Numeric

Optional

PmsId

This is the Partner Management System ID.

String

Optional

VehicletrackingId

This is the vehicle tracking ID.

String

Optional

Description

This is to state a description for the creating team.

String

Optional

Email

This is to state a email address/addresses for the team.

String

Optional

VehicleRegistrationNo

This is the vehicle registration number.

String

Optional

Status

This is to state the status of the team whether it is in active status or not.

String

Optional

Response

Status code  : 201

{
    "Description": "Successfully Updated the team",
    "TeamId": "TEST_A"
}

Get Team Details

Request

Given below is a sample request of the send service.

URL

https://ideabiz.lk/apicall/WomTeam/V1.0

Sample URL

https://ideabiz.lk/apicall/WomTeam/V1.0?DepotId={DEPOTID}&TeamId={TEAMID}&channel={channel}

Method

GET


Given below are the Request parameters in Getting Team Details.



Parameter Name

Description

Type

Mandatory/Optional

DepotId

This is the depot ID of the team.

Numeric

Mandatory

TeamId

This is the unique Team ID.

String

Optional

Channel

This is the indication of the courier channel.

String

Mandatory

Response

Status code  : 200

{
    "Description": "Query Successful",
    "Records": 
    {
        "count": 1,
        "details": [

        {
            "TeamId": "TEST_A",
            "Description": "Test Team",
            "RegionCode": "COL",
            "Status": "Y",
            "TeamLeader": "John Snow",
            "ContactNumber": "777123456",
            "Ownership": "Dialog",
            "Email": "john@d.lk",
            "VehicleType": "VAN",
            "VehicleRegistrationNo": "252-8787",
            "DepotId": 1,
            "VehicletrackingId": "5458",
            "PmsId": "12365",
            "AgentMsisdn": 777123456,
            "AgentNic": "871111114V",
            "ItouchReference": "123456"
}
    ],
    }
        }
Last updated on 26th Aug 2018